<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>CommUtil xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/mbari/comm/CommUtil.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * @(#)CommUtil.java   2009.02.24 at 09:45:33 PST</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * Copyright 2007 MBARI</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> * <a href="http://www.gnu.org/copyleft/lesser.html" target="alexandria_uri">http://www.gnu.org/copyleft/lesser.html</a></em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a name="17" href="#17">17</a>  <em class="jxr_comment"> */</em>
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <em class="jxr_comment">/*</em>
<a name="22" href="#22">22</a>  <em class="jxr_comment"> * The Monterey Bay Aquarium Research Institute (MBARI) provides this</em>
<a name="23" href="#23">23</a>  <em class="jxr_comment"> * documentation and code 'as is', with no warranty, express or</em>
<a name="24" href="#24">24</a>  <em class="jxr_comment"> * implied, of its quality or consistency. It is provided without support and</em>
<a name="25" href="#25">25</a>  <em class="jxr_comment"> * without obligation on the part of MBARI to assist in its use, correction,</em>
<a name="26" href="#26">26</a>  <em class="jxr_comment"> * modification, or enhancement. This information should not be published or</em>
<a name="27" href="#27">27</a>  <em class="jxr_comment"> * distributed to third parties without specific written permission from MBARI</em>
<a name="28" href="#28">28</a>  <em class="jxr_comment"> */</em>
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">package</strong> org.mbari.comm;
<a name="30" href="#30">30</a>  
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> gnu.io.CommPort;
<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> gnu.io.CommPortIdentifier;
<a name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> gnu.io.PortInUseException;
<a name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> java.util.Enumeration;
<a name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> java.util.HashSet;
<a name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment">/**</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;Utilities for use with the javax.comm package.&lt;/p&gt;</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> *</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> *@author     &lt;a href="<a href="http://www.mbari.org" target="alexandria_uri">http://www.mbari.org</a>"&gt;MBARI&lt;/a&gt;</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> *@created    October 3, 2004</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> *@version    $Id: CommUtil.java 265 2006-06-20 05:30:09Z hohonuuli $</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> */</em>
<a name="46" href="#46">46</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/mbari/comm/CommUtil.html">CommUtil</a> {
<a name="47" href="#47">47</a>  
<a name="48" href="#48">48</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(CommUtil.<strong class="jxr_keyword">class</strong>);
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>      <em class="jxr_javadoccomment">/**</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">     * No instantiation allowed</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">     */</em>
<a name="53" href="#53">53</a>      <strong class="jxr_keyword">private</strong> <a href="../../../org/mbari/comm/CommUtil.html">CommUtil</a>() {
<a name="54" href="#54">54</a>          <strong class="jxr_keyword">super</strong>();
<a name="55" href="#55">55</a>      }
<a name="56" href="#56">56</a>  
<a name="57" href="#57">57</a>      <em class="jxr_javadoccomment">/**</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     * @return    A HashSet containing the CommPortIdentifier for all serial ports that are not currently being used.</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     */</em>
<a name="60" href="#60">60</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HashSet&lt;CommPortIdentifier&gt; getAvailableSerialPorts() {
<a name="61" href="#61">61</a>          HashSet&lt;CommPortIdentifier&gt; h = <strong class="jxr_keyword">new</strong> HashSet&lt;CommPortIdentifier&gt;();
<a name="62" href="#62">62</a>          Enumeration thePorts = CommPortIdentifier.getPortIdentifiers();
<a name="63" href="#63">63</a>  
<a name="64" href="#64">64</a>          <strong class="jxr_keyword">while</strong> (thePorts.hasMoreElements()) {
<a name="65" href="#65">65</a>              CommPortIdentifier com = (CommPortIdentifier) thePorts.nextElement();
<a name="66" href="#66">66</a>  
<a name="67" href="#67">67</a>              <strong class="jxr_keyword">switch</strong> (com.getPortType()) {
<a name="68" href="#68">68</a>              <strong class="jxr_keyword">case</strong> CommPortIdentifier.PORT_SERIAL:
<a name="69" href="#69">69</a>                  <strong class="jxr_keyword">try</strong> {
<a name="70" href="#70">70</a>                      CommPort thePort = com.open(<span class="jxr_string">"CommUtil"</span>, 50);
<a name="71" href="#71">71</a>  
<a name="72" href="#72">72</a>                      thePort.close();
<a name="73" href="#73">73</a>                      log.debug(<span class="jxr_string">"Serial Port, "</span> + com.getName() + <span class="jxr_string">", is available"</span>);
<a name="74" href="#74">74</a>                      h.add(com);
<a name="75" href="#75">75</a>                  }
<a name="76" href="#76">76</a>                  <strong class="jxr_keyword">catch</strong> (PortInUseException e) {
<a name="77" href="#77">77</a>                      <strong class="jxr_keyword">if</strong> (log.isInfoEnabled()) {
<a name="78" href="#78">78</a>                          log.debug(<span class="jxr_string">"Serial port, "</span> + com.getName() + <span class="jxr_string">", is in use."</span>);
<a name="79" href="#79">79</a>                      }
<a name="80" href="#80">80</a>                  }
<a name="81" href="#81">81</a>                  <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="82" href="#82">82</a>                      <strong class="jxr_keyword">if</strong> (log.isErrorEnabled()) {
<a name="83" href="#83">83</a>                          log.error(<span class="jxr_string">"Failed to open serial port "</span> + com.getName(), e);
<a name="84" href="#84">84</a>                      }
<a name="85" href="#85">85</a>                  }
<a name="86" href="#86">86</a>              }
<a name="87" href="#87">87</a>          }
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>          <strong class="jxr_keyword">return</strong> h;
<a name="90" href="#90">90</a>      }
<a name="91" href="#91">91</a>  
<a name="92" href="#92">92</a>      <em class="jxr_javadoccomment">/**</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * @return    A HashSet containing the CommPortIdentifier for all serial ports.</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     */</em>
<a name="95" href="#95">95</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HashSet getParallelPorts() {
<a name="96" href="#96">96</a>          HashSet h = <strong class="jxr_keyword">new</strong> HashSet();
<a name="97" href="#97">97</a>          Enumeration thePorts = CommPortIdentifier.getPortIdentifiers();
<a name="98" href="#98">98</a>  
<a name="99" href="#99">99</a>          <strong class="jxr_keyword">while</strong> (thePorts.hasMoreElements()) {
<a name="100" href="#100">100</a>             CommPortIdentifier com = (CommPortIdentifier) thePorts.nextElement();
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>             <strong class="jxr_keyword">switch</strong> (com.getPortType()) {
<a name="103" href="#103">103</a>             <strong class="jxr_keyword">case</strong> CommPortIdentifier.PORT_PARALLEL:
<a name="104" href="#104">104</a>                 h.add(com);
<a name="105" href="#105">105</a>             }
<a name="106" href="#106">106</a>         }
<a name="107" href="#107">107</a> 
<a name="108" href="#108">108</a>         <strong class="jxr_keyword">return</strong> h;
<a name="109" href="#109">109</a>     }
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>     <em class="jxr_javadoccomment">/**</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * @return    A HashSet containing the CommPortIdentifier for all serial ports.</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     */</em>
<a name="114" href="#114">114</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HashSet&lt;CommPortIdentifier&gt; getSerialPorts() {
<a name="115" href="#115">115</a>         HashSet&lt;CommPortIdentifier&gt; h = <strong class="jxr_keyword">new</strong> HashSet&lt;CommPortIdentifier&gt;();
<a name="116" href="#116">116</a>         Enumeration thePorts = CommPortIdentifier.getPortIdentifiers();
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>         <strong class="jxr_keyword">while</strong> (thePorts.hasMoreElements()) {
<a name="119" href="#119">119</a>             CommPortIdentifier com = (CommPortIdentifier) thePorts.nextElement();
<a name="120" href="#120">120</a> 
<a name="121" href="#121">121</a>             <strong class="jxr_keyword">switch</strong> (com.getPortType()) {
<a name="122" href="#122">122</a>             <strong class="jxr_keyword">case</strong> CommPortIdentifier.PORT_SERIAL:
<a name="123" href="#123">123</a>                 h.add(com);
<a name="124" href="#124">124</a>             }
<a name="125" href="#125">125</a>         }
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>         <strong class="jxr_keyword">return</strong> h;
<a name="128" href="#128">128</a>     }
<a name="129" href="#129">129</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

